Klasse ConsolePresenter

java.lang.Object

com.inet.pdfc.presenter.BasePresenter

com.inet.pdfc.presenter.ConsolePresenter

Alle implementierten Schnittstellen:

NamedExtension

public class ConsolePresenter
extends BasePresenter

A presenter to print the Modifications of a comparison run to the log. If used for a batch comparison the presenter will print a summary for all compared documents at the end of the batch run.

Verschachtelte Klassen - Übersicht

Von Klasse geerbte verschachtelte Klassen/Schnittstellen BasePresenter

BasePresenter.ERROR_SOURCE

Feldübersicht

Von Klasse geerbte Felder BasePresenter

LOGGER, MAX_FILENAME_LENGTH

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
ConsolePresenter()

Methodenübersicht

Modifikator und Typ	Methode	Beschreibung
protected boolean	canInformUserOnErrors()	Returns whether the presenter is able to handle errors in a way to notify the user.
String	getExtensionName()	Returns the UNIQUE name of the extension.
void	onComparisonDone()	Called to indicate that a comparison has finished.
void	onError(ExceptionData error, boolean interrupted, BasePresenter.ERROR_SOURCE source)	Called in case of an error that occurred either in one of the parser threads or in the compare thread. NOTE: This method is only called for exceptions which are notified to the ResultModel.
void	onFinish()	OPTIONAL: Called in case of batch comparison at the end of all comparisons of the batch run.
void	onInit()	Called at the time the document informations have been set.
void	setLogWriter(PrintWriter writer)	Sets a writer to print the result to
void	setMaxErrors(int maxErrors)	Sets the maximum number of errors to be displayed per comparison.
ConsolePresenter	spawn(boolean spawnWithParent)	Creates another presenter of the the same type as the current one.

Von Klasse geerbte Methoden BasePresenter

createExportFilename, detachFromModel, executeImmediately, getDefaultExportName, getLastPresenterException, getModel, getParent, getPresenterExceptions, onClear, onDataUpdate, onFilterChange, onProgressUpdate, setModel, setParent

Von Klasse geerbte Methoden Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Konstruktordetails

ConsolePresenter

public ConsolePresenter()

Methodendetails

getExtensionName

public String getExtensionName()

Returns the UNIQUE name of the extension. With UNIQUE referring to 'unique among all implementations of the same interface'

Gibt zurück:

the UNIQUE name of the extension

setLogWriter

public void setLogWriter(PrintWriter writer)

Sets a writer to print the result to

Parameter:

writer - the writer to print the result to, if null the default logger will be used

Seit:

i-net PDFC 4.0

onInit

public void onInit()
            throws Exception

Called at the time the document informations have been set.

Setzt außer Kraft:

onInit in Klasse BasePresenter

Löst aus:

Exception - thrown in case the processing of the init step fails

setMaxErrors

public void setMaxErrors(int maxErrors)

Sets the maximum number of errors to be displayed per comparison. Any further error will just be summed up in a comparison.

Parameter:

maxErrors - the maximum number of Modification

Seit:

i-net PDFC 3.0

onComparisonDone

public void onComparisonDone()
                      throws Exception

Called to indicate that a comparison has finished. This does not imply that any page data or differences are available.

Angegeben von:

onComparisonDone in Klasse BasePresenter

Löst aus:

Exception - thrown in case the processing of the finish step fails

onFinish

public void onFinish()

OPTIONAL: Called in case of batch comparison at the end of all comparisons of the batch run. This method cannot be triggered by an event of any referenced result model. It's sole purpose is to serve as a callback for the PDFComparer.batchCompare(java.io.File, java.io.File) method.
NOTE: This method only called once per batch compare and only for the root presenter, never for spawned ones.

Setzt außer Kraft:

onFinish in Klasse BasePresenter

onError

public void onError(ExceptionData error,
 boolean interrupted,
 BasePresenter.ERROR_SOURCE source)

Called in case of an error that occurred either in one of the parser threads or in the compare thread.
NOTE: This method is only called for exceptions which are notified to the ResultModel.

Setzt außer Kraft:

onError in Klasse BasePresenter

Parameter:

error - the exception

interrupted - indicates whether the comparison was interrupted due to this exception. If true there will be no further calls (e.g. onComparisonDone)

source - the source module of the exception.

canInformUserOnErrors

protected boolean canInformUserOnErrors()

Returns whether the presenter is able to handle errors in a way to notify the user. E.g. write the error to the log file/console or pop up an error dialog.

Setzt außer Kraft:

canInformUserOnErrors in Klasse BasePresenter

Gibt zurück:

true of BasePresenter.onError(ExceptionData, boolean, ERROR_SOURCE) will directly inform the user.

spawn

public ConsolePresenter spawn(boolean spawnWithParent)

Creates another presenter of the the same type as the current one. The spawned presenter may either have the same settings as the current one or it may be a child of the current one.

Setzt außer Kraft:

spawn in Klasse BasePresenter

Parameter:

spawnWithParent - if true, the presenter is allowed to keep a reference to it's parent to create a summary on onFinish()

Gibt zurück:

a new presenter for the same batch comparison run as the current one